From 8438880906722681f54848f7f335e0bc074afd43 Mon Sep 17 00:00:00 2001 From: Bastien Nocera Date: Wed, 25 Jul 2018 17:18:55 +0200 Subject: [PATCH] window: Deprecate gtk_window_present() And expect gtk_window_present_with_time() to be used instead. --- gtk/gtkwindow.c | 41 ++++++++++++++++++++++------------------- gtk/gtkwindow.h | 2 +- 2 files changed, 23 insertions(+), 20 deletions(-) diff --git a/gtk/gtkwindow.c b/gtk/gtkwindow.c index 719967cd64..a9cd0945c1 100644 --- a/gtk/gtkwindow.c +++ b/gtk/gtkwindow.c @@ -8736,23 +8736,11 @@ gtk_window_snapshot (GtkWidget *widget, * gtk_window_present: * @window: a #GtkWindow * - * Presents a window to the user. This may mean raising the window - * in the stacking order, deiconifying it, moving it to the current - * desktop, and/or giving it the keyboard focus, possibly dependent - * on the user’s platform, window manager, and preferences. - * - * If @window is hidden, this function calls gtk_widget_show() - * as well. - * - * This function should be used when the user tries to open a window - * that’s already open. Say for example the preferences dialog is - * currently open, and the user chooses Preferences from the menu - * a second time; use gtk_window_present() to move the already-open dialog - * where the user can see it. + * Presents a window to the user. This function should not be used + * as when it is called, it is too late to gather a valid timestamp + * to allow focus stealing prevention to work correctly. * - * If you are calling this function in response to a user interaction, - * it is preferable to use gtk_window_present_with_time(). - * + * Deprecated: 4.0: Use gtk_window_present_with_time() instead. **/ void gtk_window_present (GtkWindow *window) @@ -8766,9 +8754,24 @@ gtk_window_present (GtkWindow *window) * @timestamp: the timestamp of the user interaction (typically a * button or key press event) which triggered this call * - * Presents a window to the user in response to a user interaction. - * If you need to present a window without a timestamp, use - * gtk_window_present(). See gtk_window_present() for details. + * Presents a window to the user. This may mean raising the window + * in the stacking order, deiconifying it, moving it to the current + * desktop, and/or giving it the keyboard focus, possibly dependent + * on the user’s platform, window manager, and preferences. + * + * If @window is hidden, this function calls gtk_widget_show() + * as well. + * + * This function should be used when the user tries to open a window + * that’s already open. Say for example the preferences dialog is + * currently open, and the user chooses Preferences from the menu + * a second time; use gtk_window_present() to move the already-open dialog + * where the user can see it. + * + * Presents a window to the user in response to a user interaction. The + * timestamp should be gathered when the window was requested to be shown + * (when clicking a link for example), rather than once the window is + * ready to be shown. **/ void gtk_window_present_with_time (GtkWindow *window, diff --git a/gtk/gtkwindow.h b/gtk/gtkwindow.h index fb30ab99b8..c21d5261c4 100644 --- a/gtk/gtkwindow.h +++ b/gtk/gtkwindow.h @@ -324,7 +324,7 @@ GDK_AVAILABLE_IN_ALL gboolean gtk_window_propagate_key_event (GtkWindow *window, GdkEventKey *event); -GDK_AVAILABLE_IN_ALL +GDK_DEPRECATED_IN_4_0_FOR(gtk_window_present_with_time) void gtk_window_present (GtkWindow *window); GDK_AVAILABLE_IN_ALL void gtk_window_present_with_time (GtkWindow *window, -- 2.30.2